feat(instrumentation-koa): Add support for koa 3 #2957

tlindhardt · 2025-07-23T21:21:57Z

Which problem is this PR solving?

During the upgrade of our project from v2 to v3 I noticed that the span name was not correct and the attributes were missing. Upon further inspection I found that the instrumentation was being skipped entirely.

Short description of the changes

Switched to ATTR_HTTP_ROUTE from SEMATTRS_HTTP_ROUTE
Add support to instrumentation-koa for koa v3
Updated tests
- This includes removing a test to validate the generator middleware is skipped as that is no longer supported and mentioned in the upgrade guide

linux-foundation-easycla · 2025-07-23T21:22:01Z

The committers listed above are authorized under a signed CLA.

✅ login: tlindhardt / name: Tyson Lindhardt (795babd, 5d54143, 6acb82b, a1ea9a2)
✅ login: david-luna / name: David Luna (4e96d74, a9af84b, a20ad4f, 2e8d033)

tlindhardt · 2025-07-23T21:35:18Z

I wasn't sure of the release process and if I needed to also change the manifest file or not.

github-actions · 2025-07-24T06:43:57Z

This package does not have an assigned component owner and is considered unmaintained. As such this package is in feature-freeze and this PR will be closed with 14 days unless a new owner or a sponsor (a member of @open-telemetry/javascript-approvers) for the feature is found. It is the responsibility of the author to find a sponsor for this feature.
Are you familiar with this package? Consider becoming a component owner.

packages/instrumentation-koa/test/koa.test.ts

dyladan · 2025-08-06T16:49:00Z

@seemk @JacksonWeber are either of you interested in becoming component owner here?

packages/instrumentation-koa/src/instrumentation.ts

tlindhardt · 2025-08-20T15:42:34Z

I went ahead and applied the requested changes.

packages/instrumentation-koa/.tav.yml

packages/instrumentation-koa/test/koa.test.ts

david-luna · 2025-09-10T14:52:11Z

@tlindhardt

Thanks for contributing to OpenTelemetry. And sorry for getting here after 3 weeks.

I'll have this PR in my radar from now on. Please resolve the conflicts and read my comments

david-luna · 2025-09-10T16:21:12Z

I sponsor this PR.

tlindhardt · 2025-09-10T18:37:04Z

@david-luna I went ahead and made the requested changes. I wasn't exactly sure the best way to not run the test in 3.0 but let me know what you think.

Thanks!

codecov · 2025-09-10T22:28:46Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.44%. Comparing base (f6e8e1c) to head (2e8d033).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2957   +/-   ##
=======================================
  Coverage   91.44%   91.44%           
=======================================
  Files         146      146           
  Lines        8194     8194           
  Branches     1846     1846           
=======================================
  Hits         7493     7493           
  Misses        701      701

Flag	Coverage Δ
instrumentation-amqplib	`91.25% <ø> (ø)`
instrumentation-aws-lambda	`94.66% <ø> (ø)`
instrumentation-aws-sdk	`86.48% <ø> (ø)`
instrumentation-bunyan	`98.47% <ø> (ø)`
instrumentation-cassandra-driver	`84.02% <ø> (ø)`
instrumentation-connect	`98.47% <ø> (ø)`
instrumentation-cucumber	`92.72% <ø> (ø)`
instrumentation-dataloader	`98.12% <ø> (ø)`
instrumentation-dns	`96.87% <ø> (ø)`
instrumentation-express	`98.14% <ø> (ø)`
instrumentation-fastify	`93.98% <ø> (ø)`
instrumentation-generic-pool	`40.54% <ø> (ø)`
instrumentation-graphql	`93.99% <ø> (ø)`
instrumentation-hapi	`99.06% <ø> (ø)`
instrumentation-ioredis	`91.08% <ø> (ø)`
instrumentation-kafkajs	`97.89% <ø> (ø)`
instrumentation-knex	`94.61% <ø> (ø)`
instrumentation-koa	`96.22% <100.00%> (ø)`
instrumentation-lru-memoizer	`100.00% <ø> (ø)`
instrumentation-memcached	`92.00% <ø> (ø)`
instrumentation-mongodb	`88.25% <ø> (ø)`
instrumentation-mongoose	`90.74% <ø> (ø)`
instrumentation-mysql	`93.36% <ø> (ø)`
instrumentation-mysql2	`95.91% <ø> (ø)`
instrumentation-nestjs-core	`96.11% <ø> (ø)`
instrumentation-net	`96.55% <ø> (ø)`
instrumentation-openai	`87.96% <ø> (ø)`
instrumentation-oracledb	`96.13% <ø> (ø)`
instrumentation-pg	`95.95% <ø> (ø)`
instrumentation-pino	`100.00% <ø> (ø)`
instrumentation-redis	`85.34% <ø> (ø)`
instrumentation-restify	`91.53% <ø> (ø)`
instrumentation-router	`97.16% <ø> (ø)`
instrumentation-runtime-node	`89.47% <ø> (ø)`
instrumentation-socket.io	`81.13% <ø> (ø)`
instrumentation-tedious	`92.10% <ø> (ø)`
instrumentation-typeorm	`90.50% <ø> (ø)`
instrumentation-undici	`91.78% <ø> (ø)`
instrumentation-winston	`79.60% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...ackages/instrumentation-koa/src/instrumentation.ts	`95.18% <ø> (ø)`
packages/instrumentation-koa/src/utils.ts	`100.00% <100.00%> (ø)`

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

david-luna · 2025-09-11T18:33:36Z

packages/instrumentation-koa/test/koa.test.ts


-    it('should not instrument generator middleware functions', async () => {
+    it('should not instrument generator middleware functions', async function () {
+      if (typeof (app as any).createAsyncCtxStorageMiddleware !== 'function') {


Nit: a comment here saying why we skip the test for koa@3 would be helpful.

otelbot · 2025-09-15T18:12:45Z

Thank you for your contribution @tlindhardt! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey.

tlindhardt requested a review from a team as a code owner July 23, 2025 21:21

github-actions bot added pkg:instrumentation-koa pkg-status:unmaintained This package is unmaintained. Only bugfixes may be acceped until a new owner has been found. labels Jul 23, 2025

tlindhardt force-pushed the feat/instrumentation-koa/koa3-support branch from b499b4b to bdcd88a Compare July 23, 2025 21:33

github-actions bot added the pkg-status:unmaintained:autoclose-scheduled label Jul 24, 2025

seemk approved these changes Jul 24, 2025

View reviewed changes

tlindhardt mentioned this pull request Jul 29, 2025

chore(deps): update dependency koa to v2.16.2 [security] #2961

Merged

1 task

JacksonWeber reviewed Aug 4, 2025

View reviewed changes

packages/instrumentation-koa/test/koa.test.ts Show resolved Hide resolved

raphael-theriault-swi suggested changes Aug 7, 2025

View reviewed changes

packages/instrumentation-koa/src/instrumentation.ts Outdated Show resolved Hide resolved

tlindhardt force-pushed the feat/instrumentation-koa/koa3-support branch 2 times, most recently from 1e36d6a to 487143e Compare August 20, 2025 15:41

david-luna requested changes Sep 10, 2025

View reviewed changes

packages/instrumentation-koa/.tav.yml Outdated Show resolved Hide resolved

packages/instrumentation-koa/test/koa.test.ts Show resolved Hide resolved

david-luna added has:sponsor This package or feature has a sponsor that has volunteered to review PRs and respond to questions and removed pkg-status:unmaintained:autoclose-scheduled labels Sep 10, 2025

tlindhardt added 2 commits September 10, 2025 13:43

feat(instrumentation-koa): Add support for koa 3

a1ea9a2

Update to 3.0.1 for security fix, add recommendation to support <4

5d54143

tlindhardt force-pushed the feat/instrumentation-koa/koa3-support branch 2 times, most recently from 2512466 to 76e1b10 Compare September 10, 2025 18:49

Revert test changes to support 2.7.0+

795babd

tlindhardt force-pushed the feat/instrumentation-koa/koa3-support branch from 76e1b10 to 795babd Compare September 10, 2025 18:50

fix lint issues

6acb82b

david-luna approved these changes Sep 11, 2025

View reviewed changes

david-luna added 3 commits September 12, 2025 16:26

Merge branch 'main' into feat/instrumentation-koa/koa3-support

4e96d74

Merge branch 'main' into feat/instrumentation-koa/koa3-support

a9af84b

Merge branch 'main' into feat/instrumentation-koa/koa3-support

a20ad4f

david-luna enabled auto-merge (squash) September 15, 2025 14:52

Merge branch 'main' into feat/instrumentation-koa/koa3-support

2e8d033

david-luna merged commit 8d97f81 into open-telemetry:main Sep 15, 2025
16 checks passed

david-luna mentioned this pull request Sep 15, 2025

chore(deps): update dependency @types/koa to v3 #2963

Closed

1 task

This was referenced Sep 18, 2025

chore: release main #3072

Closed

chore: release main #3087

Closed

chore: release main #3089

Closed

chore: release main #3091

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(instrumentation-koa): Add support for koa 3 #2957

feat(instrumentation-koa): Add support for koa 3 #2957

Uh oh!

tlindhardt commented Jul 23, 2025

Uh oh!

linux-foundation-easycla bot commented Jul 23, 2025 •

edited

Loading

Uh oh!

tlindhardt commented Jul 23, 2025

Uh oh!

github-actions bot commented Jul 24, 2025

Uh oh!

Uh oh!

dyladan commented Aug 6, 2025

Uh oh!

Uh oh!

tlindhardt commented Aug 20, 2025

Uh oh!

Uh oh!

Uh oh!

david-luna commented Sep 10, 2025

Uh oh!

david-luna commented Sep 10, 2025

Uh oh!

tlindhardt commented Sep 10, 2025

Uh oh!

codecov bot commented Sep 10, 2025 •

edited

Loading

Uh oh!

david-luna Sep 11, 2025 •

edited

Loading

Uh oh!

Uh oh!

otelbot bot commented Sep 15, 2025

Uh oh!

Uh oh!

feat(instrumentation-koa): Add support for koa 3 #2957

feat(instrumentation-koa): Add support for koa 3 #2957

Uh oh!

Conversation

tlindhardt commented Jul 23, 2025

Which problem is this PR solving?

Short description of the changes

Uh oh!

linux-foundation-easycla bot commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tlindhardt commented Jul 23, 2025

Uh oh!

github-actions bot commented Jul 24, 2025

Uh oh!

Uh oh!

dyladan commented Aug 6, 2025

Uh oh!

Uh oh!

tlindhardt commented Aug 20, 2025

Uh oh!

Uh oh!

Uh oh!

david-luna commented Sep 10, 2025

Uh oh!

david-luna commented Sep 10, 2025

Uh oh!

tlindhardt commented Sep 10, 2025

Uh oh!

codecov bot commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

david-luna Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

otelbot bot commented Sep 15, 2025

Uh oh!

Uh oh!

linux-foundation-easycla bot commented Jul 23, 2025 •

edited

Loading

codecov bot commented Sep 10, 2025 •

edited

Loading

david-luna Sep 11, 2025 •

edited

Loading